Skip to content

Support callables and dataclasses in Annotated metadata #12622

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 9 commits into from
Jul 20, 2024
Merged

Support callables and dataclasses in Annotated metadata #12622

merged 9 commits into from
Jul 20, 2024

Conversation

@AA-Turner
Copy link
Member

@AA-Turner AA-Turner commented Jul 19, 2024

Resolves #12601

cc: @2bndy5 -- Brendan, if you'd be able to test this PR I would be grateful.

A

@AA-Turner AA-Turner added this to the 7.4.x milestone Jul 19, 2024
@2bndy5
Copy link

2bndy5 commented Jul 19, 2024

Using the zip from #12601 thread, I now get the following nitpicky warnings:

path/to/issue#12601/annotated.py:docstring of annotated.CustomAdmonitionConfig:1: WARNING: py:class reference target not found: pydantic.functional_validators.AfterValidator
path/to/issue#12601/annotated.py:docstring of annotated.CustomAdmonitionConfig:1: WARNING: py:class reference target not found: docutils.nodes.make_id
path/to/issue#12601/annotated.py:docstring of annotated.CustomAdmonitionConfig.classes:1: WARNING: py:class reference target not found: pydantic.functional_validators.AfterValidator
path/to/issue#12601/annotated.py:docstring of annotated.CustomAdmonitionConfig.classes:1: WARNING: py:class reference target not found: docutils.nodes.make_id
path/to/issue#12601/annotated.py:docstring of annotated.CustomAdmonitionConfig.title:1: WARNING: py:class reference target not found: FieldInfo
path/to/issue#12601/annotated.py:docstring of annotated.CustomAdmonitionConfig.title:1: WARNING: py:class reference target not found: NoneType

after adding to conf.py:

extensions = [
    "sphinx.ext.autodoc",
    "sphinx.ext.intersphinx",
]
autodoc_mock_imports = [
    "docutils",
    "pydantic",
]
intersphinx_mapping = {
    "python": ("https://docs.python.org/3", None),
}

I get the following nitpicky warnings:

path/to/issue#12601/annotated.py:docstring of annotated.CustomAdmonitionConfig.classes:1: WARNING: py:class reference target not found: pydantic.AfterValidator
path/to/issue#12601/annotated.py:docstring of annotated.CustomAdmonitionConfig.title:1: WARNING: py:class reference target not found: pydantic.Field

with the following HTML output:
image
Overall, I think this is a considerable improvement. Thanks!

@AA-Turner AA-Turner force-pushed the fix-annotated-autodoc branch from 296ee42 to aafa5fd Compare July 20, 2024 03:27
@AA-Turner AA-Turner force-pushed the fix-annotated-autodoc branch from aafa5fd to db56cef Compare July 20, 2024 03:44
@AA-Turner AA-Turner mentioned this pull request Jul 20, 2024
Merged
@AA-Turner AA-Turner merged commit 2bd973e into sphinx-doc:master Jul 20, 2024
@AA-Turner AA-Turner deleted the fix-annotated-autodoc branch July 20, 2024 10:28
@AA-Turner
Copy link
Member Author

AA-Turner commented Jul 20, 2024

Thanks @2bndy5!

A

@2bndy5
Copy link

2bndy5 commented Jul 20, 2024

Thank you for taking the lead on this!

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 21, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

No reviews

Assignees

No one assigned

Labels

domains:py extensions:autodoc type:regression

Projects

None yet

Milestone

7.4.x

Development

Successfully merging this pull request may close these issues.

Sphinx 7.4: autodoc: typing.Annotated failure with pydantic

2 participants

@AA-Turner @2bndy5